Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: more intro and docs outline #22

Merged
merged 2 commits into from
May 6, 2019
Merged

docs: more intro and docs outline #22

merged 2 commits into from
May 6, 2019

Conversation

mattklein123
Copy link
Member

Signed-off-by: Matt Klein [email protected]

@mattklein123
Copy link
Member Author

@junr03 @goaway @buildbreaker these are some getting started docs that should get us in a place where folks can start filling in specific pieces. The "what is Envoy Mobile" page is a lightly edited version of the blog post. PTAL.

Copy link
Member

@junr03 junr03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two small comments. Otherwise this scaffolding -- and initial content -- lgtm.

docs/root/intro/comparison.rst Outdated Show resolved Hide resolved
new features are added, and eventually split out into proper documentation. Our initial milestones
can be `viewed in GitHub <https://github.com/lyft/envoy-mobile/milestones>`_.

* Ability to compile Envoy on both Android and iOS.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we be more specific about what we can compile? Maybe not in this PR, but a todo for specifics from @goaway?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we should be more specific throughout these docs, but will leave it to others to update when the code and demos are finalized.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌 we have https://github.com/lyft/envoy-edge-dev/issues/65 for demos, and I just created #23 for documenting components.

Signed-off-by: Matt Klein <[email protected]>
@mattklein123
Copy link
Member Author

@junr03 @buildbreaker updated

Copy link
Member

@junr03 junr03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

new features are added, and eventually split out into proper documentation. Our initial milestones
can be `viewed in GitHub <https://github.com/lyft/envoy-mobile/milestones>`_.

* Ability to compile Envoy on both Android and iOS.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌 we have https://github.com/lyft/envoy-edge-dev/issues/65 for demos, and I just created #23 for documenting components.

@mattklein123
Copy link
Member Author

Let's just ship this and we can iterate in parallel.

@mattklein123 mattklein123 merged commit 2e8358c into master May 6, 2019
@mattklein123 mattklein123 deleted the more_docs branch May 6, 2019 18:58
@Augustyniak Augustyniak mentioned this pull request Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants